High-level diagrams for openfold's codebase#543
Conversation
|
Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding |
|
Hi Ivan, |
|
Yes I understand your point, also i twill make the graph easier to read as it will be less busy. Writting that down as feedback! Thanks will let you know when we have the next version! |
2 participants
I have generated high-level diagrams for the openfold project. The idea is to help people get up-to-speed with the codebase (as contributors), you can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/openfold/on_boarding.md
These diagrams are designed to help people quickly understand a codebase. We believe that, especially considerting that a lot of scientists interact with this codebase, they can benefit a lot from visualization like the one we have, instead of having to read the full codebase. Also considering the 600+ forks, there are a lot of people who edit the codebase, I suppose that usually they are interested in just one component, with the diagram they can immediatly navigate to it and have the context on how it interacts with the rest of the codebase!
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.